home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / sound / vocpak10.zip / VP.DOC next >
Text File  |  1993-02-03  |  7KB  |  212 lines
  1.                                   VOCPACK
  2.                                      
  3.                Lossless 8-bit sound compressor/decompressor
  4.                      Copyright (C) 1993 Nicola Ferioli
  5.  
  6.  
  7.  
  8. Version: 1.0
  9. Date:    3 February 1993
  10.  
  11. Distribution files:
  12.  
  13.    VP.EXE       Ms-Dos executable
  14.    VP.DOC       This document
  15.  
  16.  
  17.  
  18. =============================================================================
  19.  
  20.  
  21. 1  -  INTRODUCTION
  22.  
  23.  
  24. VOCPACK is a compressor/decompressor for 8-bit digital sound using a
  25. lossless algorithm; it is useful to save disk space without degrading sound
  26. quality.
  27. It can compress signed and unsigned data, sampled at any rate, mono or
  28. stereo. Since the method used is not lossy, it isn't necessary to strip
  29. file headers before compressing.
  30. VOCPACK was developed for use with .VOC (SoundBlaster) and .WAV (Windows)
  31. files, but any 8-bit sound can be compressed since the program takes no
  32. assumptions about the file structure. If you are working with signed data
  33. (like files imported from Amiga) you should use the switch -s on the
  34. command line to make VOCPACK work better; the default is to compress
  35. unsigned data (SoundBlaster standard).
  36. .MOD and .ST files are not compressed very well, since they contain a lot
  37. of sequencing information and the sound is sampled at a low frequency; in
  38. this case the files created by VOCPACK could be slightly bigger than the
  39. ones produced by general-purpose compression programs.
  40.  
  41. The typical compression ratio obtained goes from 0,8 for files sampled at
  42. 11 KHz to 0,4 for 44 Khz files. The best results are obtained with 44 KHz
  43. sounds (mono or stereo): general-purpose archivers create files that can be
  44. twice longer than the output of VOCPACK. You can obtain smaller values
  45. using lossy compressors but if your goal is to keep the sound quality
  46. unaltered you should use a lossless program like VOCPACK.
  47.  
  48.  
  49.  
  50. =============================================================================
  51.  
  52.  
  53. 2  -  PROGRAM NOTES
  54.  
  55.  
  56. This is SHAREWARE software; you are free to copy and distribute VOCPACK on
  57. condition that all files are included without any modification. No fee must
  58. be charged for such distribution, except nominal fees for magnetic support,
  59. subscription to a BBS or things like that.
  60. VOCPACK can't be included with any commercial product without a special
  61. license from the author.
  62.  
  63. If you find VOCPACK useful you are invited to send $5.00 (cash only) to:
  64.  
  65.    NICOLA FERIOLI
  66.    VIA BOEZIO 6
  67.    21052 BUSTO ARSIZIO
  68.    ITALY
  69.  
  70. This software lets you save much more than $5.00. Sound files take a lot of
  71. disk space: on a 1,44 MB floppy disk you can store only 33 seconds of
  72. 44 KHz music. With VOCPACK you can put at least 66 seconds of sound on the
  73. same media, so you will gain the equivalent price of a diskette per minute
  74. of recording.
  75.  
  76. This software is provided 'as is' with no express or implied warranty. The
  77. author is not liable for any loss of data or other damage caused by the use
  78. of this software.
  79.  
  80.  
  81.  
  82. =============================================================================
  83.  
  84.  
  85. 3  -  USAGE
  86.  
  87.  
  88. The command line of VOCPACK has the form
  89.  
  90.    VP <command> [-options] <inputfile> <outputfile>
  91.  
  92. You can type VP with no parameter to obtain a short description of the
  93. available commands and options.
  94. File names <inputfile> and <outputfile> can't contain wildcard characters,
  95. but may include drive and/or path. The suggested extension for compressed
  96. files is '.VP', but the program accepts any extension.
  97.  
  98. 'Command' is one of the following letters (lowercase or uppercase):
  99.  
  100.   c : read sound file <inputfile> and create the compressed file
  101.       <outputfile>
  102.   
  103.   d : read the compressed file <inputfile> and write the uncompressed sound
  104.       file in <outputfile>
  105.   
  106.   i : display information about <inputfile>: compression method used,
  107.       original and compressed size, compression ratio; <outputfile> is
  108.       ignored and can be omitted
  109.   
  110.   r : show registration information (more details can be found in section 2
  111.       of this document); the two file names are ignored
  112.   
  113.  
  114. 'Options' can be one or more of the following:
  115.  
  116.    o : overwrite <outputfile> if it already exists; if this switch is not
  117.        present, VOCPACK asks for confirmation before overwriting; it is
  118.        used only with commands 'c' and 'd'
  119.    
  120.    q : quiet mode, don't display the progress indicator; it has effect only
  121.        with commands 'c' and 'd'
  122.    
  123.    s : sound to be compressed is signed; by default VOCPACK compresses
  124.        unsigned data, but to achieve a good result with files containing
  125.        signed samples you should include this option; during decompression
  126.        -s is ignored since the correct value is contained in <inputfile>
  127.    
  128.  
  129. Options must be preceded by a '-' and can be placed anywhere on the command
  130. line; they can be uppercase or lowercase and they can be combined ('-oq' is
  131. the same of '-o -q').
  132.  
  133.  
  134.  
  135. =============================================================================
  136.  
  137.  
  138. 4  -  ERROR CODES
  139.  
  140.  
  141. When an error occurs, VOCPACK returns one of the following error codes (DOS
  142. errorlevel):
  143.  
  144.   1 = bad command line; the help screen was displayed
  145.   2 = input file not found
  146.   3 = output file can't be created
  147.   4 = input file is not compressed with VOCPACK
  148.   5 = user break
  149.   6 = out of memory
  150.  
  151.  
  152.  
  153. =============================================================================
  154.  
  155.  
  156. 5  -  MISCELLANEOUS THINGS
  157.  
  158.  
  159. This program is dedicated to Nadia Buraglio.
  160.  
  161. Thanks to Fabio Formenti and Carlo Larghi for their help & suggestions.
  162.  
  163. I have a working UNIX version of VOCPACK 1.0, but the source documentation
  164. is quite poor and it's written in italian; if anybody is interested in
  165. compressing sounds with UNIX, send an e-mail message to me, I could rewrite
  166. the comments and distribute the C source code.
  167.  
  168. I am developing a different algorithm that can reduce the size of the
  169. compressed file even more, but it is VERY slow and it could be used only on
  170. fast processors. If registrations for version 1.0 will be enough, I'll
  171. probably release a new version with the enhanced algorithm, maybe for 386+
  172. machines only.
  173.  
  174. Bugs, suggestions, etc. can be e-mailed to the Internet address at the end
  175. of this document.
  176.  
  177. This document contains trademarks registered by their respective owners.
  178.  
  179.  
  180. Original distribution point:    wsmr-simtel20.army.mil
  181. Simtel20 files are also available by anonymous ftp from mirror sites
  182.  
  183.         oak.oakland.edu (141.210.10.117),
  184.         wuarchive.wustl.edu (128.252.135.4),
  185.         ftp.uu.net (137.39.1.9),
  186.         nic.funet.fi (128.214.6.100),
  187.         src.doc.ic.ac.uk (146.169.3.7),
  188.         nic.switch.ch (130.59.1.40),
  189.         archie.au (139.130.4.6),
  190.         nctuccca.edu.tw (140.111.3.21),
  191.  
  192. or by e-mail through the BITNET/EARN file servers, or by uucp from UUNET's
  193. 1-900-GOT-SRCS.
  194. Please connect to a server near you.
  195.  
  196.  
  197.  
  198. ==========================================================================
  199.  
  200.  
  201. FERIOLI NICOLA
  202. VIA BOEZIO 6
  203. 21052 BUSTO ARSIZIO
  204. ITALY
  205.  
  206.  
  207. Internet:   ser1509@cdc835.cdc.polimi.it
  208.  
  209. WARNING: this Internet address will be active until the end of January
  210. 1994; after this date I will probably change user name or I'll leave
  211. Internet. You can contact me by mail however.
  212.